Define Activity Type Attributes

An Activity Type comprises one or more Attributes that describe the Member behavior or interaction. Attributes are organized into two categories: Header Attributes and Line Item Attributes.

To define the Attributes for an Activity Type:

  1. Select Program from the top navigation bar, then select Activity Types from the side navigation menu. The Activity Types screen is displayed.

  2. On the Activity Types screen, search for and select the desired Activity Type (see Search for an Activity Type for more information on the available search options). The Activity Type Details screen is displayed.

Header Attributes

Note: Each Activity Type (including both user-defined and default system Activity Types) includes a set of pre-defined System Attributes that can't be edited or deleted. These System Attributes include important data needed by the Loyalty platform to process the Activity, such as the date / time, changes in Metric accrual, and the Member ID. These System Attributes are hidden by default, but you can view them by clicking the Show System Attributes link within the Header Attributes section.

To create a Header Attribute:

  1. Within the Header Attributes section, in the text field, enter the name of the new Attribute.

  2. From the drop-down menu, select the Attribute's Data Type.

  3. Click Create. The Edit Header Attribute pop-up window is displayed.

  1. The Display Name field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Display Name value. This field is not editable by default. To edit the Internal Name, check Edit Internal Name. A confirmation dialog box is displayed; click Ok. Edit the Internal Name value.

  3. The Type drop-down menu is populated with the Data Type you selected above; optionally select a different Data Type.

  4. Optionally, in the Description field, enter a description of this item.

  5. Optionally, check API Visible to include this Attribute in API calls involving this Activity Type.

  6. Click Save. The system adds the new Attribute to the bottom of the list of Header Attributes.

  7. Repeat the above steps as needed to define additional Header Attributes. Optionally, to reorder Attributes, click-and-drag on the "handle" to the left of the Display Name, and drop the Attribute in its desired new location.

Line Item Attributes

To create a Line Item Attribute:

  1. Within the Line Item Attributes section, in the text field, enter the name of the new Attribute.

  2. From the drop-down menu, select the Attribute's Data Type.

  3. Click Create. The Edit Line Item Attribute pop-up window is displayed.

  1. The Display Name field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Display Name value. This field is not editable by default. To edit the Internal Name, check Edit Internal Name. A confirmation dialog box is displayed; click Ok. Edit the Internal Name value.

  3. The Type drop-down menu is populated with the Data Type you selected above; optionally select a different Data Type.

  4. Optionally, in the Description field, enter a description of this item.

  5. Optionally, check Add Index to index this Attribute.

  6. Optionally, check API Visible to include this Attribute in API calls involving this Activity Type.

  7. Click Save. The system adds the new Attribute to the bottom of the list of Line Item Attributes.

  8. Repeat the above steps as needed to define additional Line Item Attributes. Optionally, to reorder Attributes, click-and-drag on the "handle" to the left of the Display Name, and drop the Attribute in its desired new location.

You must deploy metadata for the Activity Type changes to take effect. For details on how to deploy metadata, see the Deployments screen.

View Sample JSON File

After adding Attributes to an Activity Type, you can view a sample JSON file to verify the JSON payload for this Activity Type. To view a sample JSON file:

  1. At the bottom of the Activity Type Details screen, in the Activity File section, click Generate Sample File.

  2. The platform creates the JSON file, and downloads it to your local PC.